home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / psion / amigancp.lha / AmigaNCP010b / Developer / Autodocs / ncp.doc
Text File  |  1994-09-26  |  20KB  |  882 lines
  1. TABLE OF CONTENTS
  2.  
  3. ncp.library/NCP_AbortRead
  4. ncp.library/NCP_AbortWrite
  5. ncp.library/NCP_BeginRead
  6. ncp.library/NCP_BeginWrite
  7. ncp.library/NCP_CheckRead
  8. ncp.library/NCP_CheckWrite
  9. ncp.library/NCP_clnl
  10. ncp.library/NCP_CloseChannel
  11. ncp.library/NCP_Fault
  12. ncp.library/NCP_ibm2iso
  13. ncp.library/NCP_ILONG
  14. ncp.library/NCP_ILONGP
  15. ncp.library/NCP_ILONGPI
  16. ncp.library/NCP_iso2ibm
  17. ncp.library/NCP_IWORD
  18. ncp.library/NCP_IWORDP
  19. ncp.library/NCP_IWORDPI
  20. ncp.library/NCP_LinkRemoteRun
  21. ncp.library/NCP_OpenChannel
  22. ncp.library/NCP_Read
  23. ncp.library/NCP_ReadSig
  24. ncp.library/NCP_WaitRead
  25. ncp.library/NCP_WaitWrite
  26. ncp.library/NCP_Write
  27. ncp.library/NCP_WriteSig
  28. ncp.library/NCP_AbortRead                           ncp.library/NCP_AbortRead
  29.  
  30.    NAME
  31.     NCP_AbortRead -- abort read currently in progress
  32.  
  33.    SYNOPSIS
  34.     NCP_AbortRead( channel )
  35.                      A0 
  36.  
  37.     void NCP_AbortRead( APTR )
  38.  
  39.    FUNCTION
  40.     Aborts the current read request on the given NCP channel.
  41.     Does nothing if no read is pending.
  42.     
  43.    INPUTS
  44.     channel -- a NCP channel created by NCP_OpenChannel()
  45.  
  46.    RESULT
  47.     None.
  48.  
  49.    EXAMPLE
  50.  
  51.    NOTES
  52.     Never forget to finish a read request using NCP_WaitRead(),
  53.     or you'll end up in OS hell.
  54.  
  55.    BUGS
  56.     None known.
  57.  
  58.    SEE ALSO
  59.     NCP_Read(), NCP_WaitRead(), NCP_CheckRead(), NCP_BeginRead()
  60.  
  61. ncp.library/NCP_AbortWrite                         ncp.library/NCP_AbortWrite
  62.  
  63.    NAME
  64.     NCP_AbortWrite -- abort write currently in progress
  65.  
  66.    SYNOPSIS
  67.     NCP_AbortWrite( channel )
  68.                      A0 
  69.  
  70.     void NCP_AbortWrite( APTR )
  71.  
  72.    FUNCTION
  73.     Aborts the current write request on the given NCP channel.
  74.     Does nothing if no write is pending.
  75.     
  76.    INPUTS
  77.     channel -- a NCP channel created by NCP_OpenChannel()
  78.  
  79.    RESULT
  80.     None.
  81.  
  82.    EXAMPLE
  83.  
  84.    NOTES
  85.     Never forget to finish a write request using NCP_WaitWrite(),
  86.     or you'll end up in OS hell.
  87.  
  88.    BUGS
  89.     None known.
  90.  
  91.    SEE ALSO
  92.     NCP_Write(), NCP_WaitWrite(), NCP_CheckWrite(), NCP_BeginWrite()
  93.  
  94. ncp.library/NCP_BeginRead                           ncp.library/NCP_BeginRead
  95.  
  96.    NAME
  97.     NCP_BeginRead -- start a read request on the NCP channel.
  98.  
  99.    SYNOPSIS
  100.     error = NCP_BeginRead( channel, data, datasize )
  101.       D0                     A0      A1       D0
  102.  
  103.     LONG NCP_BeginRead( APTR, APTR, ULON G);
  104.  
  105.    FUNCTION
  106.     Queues a read operation on the current NCP channel.
  107.    
  108.    INPUTS
  109.     channel -- a NCP channel created by NCP_OpenChannel()
  110.     data -- receive buffer
  111.     datasize -- receive buffer size
  112.  
  113.    RESULT
  114.     error -- either 0 if the read was queued successfully
  115.              or a negative error number
  116.  
  117.    EXAMPLE
  118.  
  119.    NOTES
  120.     Only one read request may be queued at a time on a single
  121.     channel. This function fails with NCPE_INUSE if there is
  122.     already a read request outstanding.
  123.  
  124.    BUGS
  125.     None known.
  126.  
  127.    SEE ALSO
  128.     NCP_Read(), NCP_WaitRead(), NCP_AbortRead(), NCP_CheckRead()
  129.  
  130. ncp.library/NCP_BeginWrite                         ncp.library/NCP_BeginWrite
  131.  
  132.    NAME
  133.     NCP_BeginWrite -- start a write request on the NCP channel.
  134.  
  135.    SYNOPSIS
  136.     error = NCP_BeginWrite( channel, data, datasize )
  137.       D0                     A0      A1       D0
  138.  
  139.     LONG NCP_BeginWrite( APTR, APTR, ULON G);
  140.  
  141.    FUNCTION
  142.     Queues a write operation on the current NCP channel.
  143.    
  144.    INPUTS
  145.     channel -- a NCP channel created by NCP_OpenChannel()
  146.     data -- data buffer
  147.     datasize -- data buffer size
  148.  
  149.    RESULT
  150.     error -- either 0 if the write was queued successfully
  151.              or a negative error number
  152.  
  153.    EXAMPLE
  154.  
  155.    NOTES
  156.     Only one write request may be queued at a time on a single
  157.     channel. This function fails with NCPE_INUSE if there is
  158.     already a write request outstanding.
  159.  
  160.    BUGS
  161.     None known.
  162.  
  163.    SEE ALSO
  164.     NCP_Write(), NCP_WaitWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  165.  
  166. ncp.library/NCP_CheckRead                           ncp.library/NCP_CheckRead
  167.  
  168.    NAME
  169.     NCP_CheckRead -- check if a read request is still pending
  170.  
  171.    SYNOPSIS
  172.     status = NCP_CheckRead( channel )
  173.       D0                       A0 
  174.  
  175.     LONG NCP_CheckRead( APTR )
  176.  
  177.    FUNCTION
  178.     Check if a read request is still pending on the given NCP
  179.     channel.
  180.    
  181.    INPUTS
  182.     channel -- a NCP channel created by NCP_OpenChannel()
  183.  
  184.    RESULT
  185.     status -- FALSE if a read is currently pending,
  186.               TRUE if no request is pending or the current
  187.               request has completed.
  188.  
  189.    EXAMPLE
  190.  
  191.    NOTES
  192.     Never forget to finish a read request using NCP_WaitRead(),
  193.     or you'll end up in OS hell.
  194.  
  195.    BUGS
  196.     None known.
  197.  
  198.    SEE ALSO
  199.     NCP_Read(), NCP_WaitRead(), NCP_AbortRead(), NCP_BeginRead()
  200.  
  201. ncp.library/NCP_CheckWrite                         ncp.library/NCP_CheckWrite
  202.  
  203.    NAME
  204.     NCP_CheckWrite -- check if a write request is still pending
  205.  
  206.    SYNOPSIS
  207.     status = NCP_CheckWrite( channel )
  208.       D0                       A0 
  209.  
  210.     LONG NCP_CheckWrite( APTR )
  211.  
  212.    FUNCTION
  213.     Check if a write request is still pending on the given NCP
  214.     channel.
  215.    
  216.    INPUTS
  217.     channel -- a NCP channel created by NCP_OpenChannel()
  218.  
  219.    RESULT
  220.     status -- FALSE if a write is currently pending,
  221.               TRUE if no request is pending or the current
  222.               request has completed.
  223.  
  224.    EXAMPLE
  225.  
  226.    NOTES
  227.     Never forget to finish a write request using NCP_WaitWrite(),
  228.     or you'll end up in OS hell.
  229.  
  230.    BUGS
  231.     None known.
  232.  
  233.    SEE ALSO
  234.     NCP_Write(), NCP_WaitWrite(), NCP_AbortWrite(), NCP_BeginWrite()
  235.  
  236. ncp.library/NCP_clnl                                     ncp.library/NCP_clnl
  237.  
  238.    NAME
  239.     NCP_clnl -- clear CR/LF at end of line.
  240.  
  241.    SYNOPSIS
  242.     NCP_clnl( string )
  243.               A0
  244.  
  245.     void NCP_clnl( STRPTR );
  246.  
  247.    FUNCTION
  248.     Clears any CR or LF characters at the end of the string.
  249.  
  250.    INPUTS
  251.     string -- pointer to string (contents will be modified)
  252.  
  253.    RESULT
  254.     None.
  255.  
  256.    EXAMPLE
  257.  
  258.    NOTES
  259.  
  260.    BUGS
  261.     None known.
  262.  
  263.    SEE ALSO
  264.  
  265. ncp.library/NCP_CloseChannel                     ncp.library/NCP_CloseChannel
  266.  
  267.    NAME
  268.     NCP_CloseChannel -- close a NCP channel
  269.  
  270.    SYNOPSIS
  271.     NCP_CloseChannel( channel )
  272.                        A0      
  273.  
  274.    void NCP_CloseChannel( APTR );
  275.  
  276.    FUNCTION
  277.     Close a NCP channel previously opened by NCP_OpenChannel().
  278.     If this is an active link to the remote machine, it will be
  279.     closed.
  280.  
  281.    INPUTS
  282.     channel -- channel to close. May be NULL, in which case
  283.                this functions does nothing.
  284.  
  285.    RESULT
  286.     None.
  287.  
  288.    EXAMPLE
  289.  
  290.    NOTES
  291.     An active NCP connection will be dropped about 10s
  292.     after the last channel has been closed.
  293.  
  294.    BUGS
  295.     None known.
  296.  
  297.    SEE ALSO
  298.     NCP_OpenChannel()
  299.  
  300. ncp.library/NCP_Fault                                   ncp.library/NCP_Fault
  301.  
  302.    NAME
  303.    NCP_Fault -- return localized NCP error string
  304.  
  305.    SYNOPSIS
  306.    NCP_Fault( code, header, buffer, buffersize );
  307.                D0     A0      A1        D1
  308.  
  309.    void NCP_Fault( LONG, STRPTR, STRPTR, ULONG );
  310.  
  311.    FUNCTION
  312.    Returns a localized text string associated with the
  313.    error code.
  314.  
  315.    INPUTS
  316.    code -- NCP error code
  317.    header -- header to insert before string. May be NULL
  318.    buffer -- buffer to write the error text to
  319.    buffersize -- size of buffer
  320.  
  321.    RESULT
  322.    None.
  323.  
  324.    EXAMPLE
  325.  
  326.    NOTES
  327.  
  328.    BUGS
  329.    None known.
  330.  
  331.    SEE ALSO
  332.    dos.library/Fault()
  333.  
  334. ncp.library/NCP_ibm2iso                               ncp.library/NCP_ibm2iso
  335.  
  336.    NAME
  337.     NCP_ibm2iso -- convert IBM to ISO charachter
  338.  
  339.    SYNOPSIS
  340.     isochar = NCP_ibm2iso( ibmchar )
  341.       D0                    D0 0:7
  342.  
  343.     UBYTE NCP_ibm2iso( UBYTE );
  344.  
  345.    FUNCTION
  346.     Converts a character from the IBM to the ISO charset.
  347.  
  348.    INPUTS
  349.     ibmchar -- character of the IBM codeset
  350.  
  351.    RESULT
  352.     isochar -- equivalent character in the ISO codeset
  353.  
  354.    EXAMPLE
  355.  
  356.    NOTES
  357.  
  358.    BUGS
  359.     None known.
  360.  
  361.    SEE ALSO
  362.  
  363. ncp.library/NCP_ILONG                                   ncp.library/NCP_ILONG
  364.  
  365.    NAME
  366.     NCP_ILONG -- swap bytes in longword
  367.  
  368.    SYNOPSIS
  369.     slongword = NCP_ILONG( longword )
  370.       D0                     D0
  371.  
  372.     ULONG NCP_ILONG( ULONG );
  373.  
  374.    FUNCTION
  375.     Swaps the byte order within the longword.
  376.  
  377.    INPUTS
  378.     longword -- a 32 bit data word.
  379.  
  380.    RESULT
  381.     slongword -- the same word with the byte order swapped.
  382.  
  383.    EXAMPLE
  384.  
  385.    NOTES
  386.  
  387.    BUGS
  388.     None known.
  389.  
  390.    SEE ALSO
  391.  
  392. ncp.library/NCP_ILONGP                                 ncp.library/NCP_ILONGP
  393.  
  394.    NAME
  395.     NCP_ILONGP -- swap bytes in longword (pointer version)
  396.  
  397.    SYNOPSIS
  398.     sword = NCP_ILONGP( longwordp1, longwordp2 )
  399.       D0                    A0          A1
  400.  
  401.     ULONG NCP_ILONGP( ULONG *, ULONG * );
  402.  
  403.    FUNCTION
  404.     Swaps the byte order from the longword pointed to by longwordp1
  405.     and places the result in the longword pointed to by longwordp2.
  406.  
  407.    INPUTS
  408.     longwordp1 -- pointer to source longword
  409.     longwordp2 -- pointer to destination longword
  410.  
  411.    RESULT
  412.     sword -- the same word with the byte order swapped.
  413.  
  414.    EXAMPLE
  415.  
  416.    NOTES
  417.     The longwords don't need to be word aligned.
  418.  
  419.    BUGS
  420.     The 68020++ version of ncp.library requires the hardware
  421.     to be able to do misaligned word accesses. Some early
  422.     accelerator boards may have problems doing this.
  423.  
  424.    SEE ALSO
  425.  
  426. ncp.library/NCP_ILONGPI                               ncp.library/NCP_ILONGPI
  427.  
  428.    NAME
  429.     NCP_ILONGPI -- swap bytes in longword (in-place pointer version)
  430.  
  431.    SYNOPSIS
  432.     sword = NCP_ILONGPI( longwordp )
  433.       D0                    A0
  434.  
  435.     ULONG NCP_ILONGP( ULONG * )
  436.  
  437.    FUNCTION
  438.     Swaps the byte order within the longword pointed to by longwordp.
  439.  
  440.    INPUTS
  441.     longwordp -- pointer to longword to swap
  442.  
  443.    RESULT
  444.     sword -- the same word with the byte order swapped.
  445.  
  446.    EXAMPLE
  447.  
  448.    NOTES
  449.     The longword doesn't need to be word aligned.
  450.  
  451.    BUGS
  452.     The 68020++ version of ncp.library requires the hardware
  453.     to be able to do misaligned word accesses. Some early
  454.     accelerator boards may have problems doing this.
  455.  
  456.    SEE ALSO
  457.  
  458. ncp.library/NCP_iso2ibm                               ncp.library/NCP_iso2ibm
  459.  
  460.    NAME
  461.     NCP_iso2ibm -- convert IBM to ISO charachter
  462.  
  463.    SYNOPSIS
  464.     ibmchar = NCP_iso2ibm( isochar )
  465.       D0                    D0 0:7
  466.  
  467.     UBYTE NCP_iso2ibm( UBYTE );
  468.  
  469.    FUNCTION
  470.     Converts a character from the ISO to the IBM charset.
  471.  
  472.    INPUTS
  473.     isochar -- character of the ISO codeset
  474.  
  475.    RESULT
  476.     ibmchar -- equivalent character in the IBM codeset
  477.  
  478.    EXAMPLE
  479.  
  480.    NOTES
  481.  
  482.    BUGS
  483.     None known.
  484.  
  485.    SEE ALSO
  486.  
  487. ncp.library/NCP_IWORD                                   ncp.library/NCP_IWORD
  488.  
  489.    NAME
  490.     NCP_IWORD -- swap bytes in word
  491.  
  492.    SYNOPSIS
  493.     sword = NCP_IWORD( word )
  494.       D0                D0
  495.  
  496.     UWORD NCP_IWORD( UWORD );
  497.  
  498.    FUNCTION
  499.     Swaps the byte order within the word.
  500.  
  501.    INPUTS
  502.     word -- a 16 bit data word.
  503.  
  504.    RESULT
  505.     sword -- the same word with the byte order swapped.
  506.  
  507.    EXAMPLE
  508.  
  509.    NOTES
  510.  
  511.    BUGS
  512.     None known.
  513.  
  514.    SEE ALSO
  515.  
  516. ncp.library/NCP_IWORDP                                 ncp.library/NCP_IWORDP
  517.  
  518.    NAME
  519.     NCP_IWORDP -- swap bytes in word (pointer version)
  520.  
  521.    SYNOPSIS
  522.     sword = NCP_IWORDP( wordp1, wordp2 )
  523.       D0                  A0      A1
  524.  
  525.     UWORD NCP_IWORDP( UWORD *, UWORD * );
  526.  
  527.    FUNCTION
  528.     Swaps the byte order from the word pointed to by wordp1
  529.     and places the result in the word pointed to by wordp2.
  530.  
  531.    INPUTS
  532.     wordp1 -- pointer to source word
  533.     wordp2 -- pointer to destination word
  534.  
  535.    RESULT
  536.     sword -- the same word with the byte order swapped.
  537.  
  538.    EXAMPLE
  539.  
  540.    NOTES
  541.     The words don't need to be word aligned.
  542.  
  543.    BUGS
  544.     The 68020++ version of ncp.library requires the hardware
  545.     to be able to do misaligned word accesses. Some early
  546.     accelerator boards may have problems doing this.
  547.  
  548.    SEE ALSO
  549.  
  550. ncp.library/NCP_IWORDPI                               ncp.library/NCP_IWORDPI
  551.  
  552.    NAME
  553.     NCP_IWORDPI -- swap bytes in word (in-place pointer version)
  554.  
  555.    SYNOPSIS
  556.     sword = NCP_IWORDPI( wordp1 )
  557.       D0                   A0
  558.  
  559.     UWORD NCP_IWORDP( UWORD * )
  560.  
  561.    FUNCTION
  562.     Swaps the byte order within the word pointed to by wordp.
  563.  
  564.    INPUTS
  565.     wordp -- pointer to word to swap
  566.  
  567.    RESULT
  568.     sword -- the same word with the byte order swapped.
  569.  
  570.    EXAMPLE
  571.  
  572.    NOTES
  573.     The word doesn't need to be word aligned.
  574.  
  575.    BUGS
  576.     The 68020++ version of ncp.library requires the hardware
  577.     to be able to do misaligned word accesses. Some early
  578.     accelerator boards may have problems doing this.
  579.  
  580.    SEE ALSO
  581.  
  582. ncp.library/NCP_LinkRemoteRun                   ncp.library/NCP_LinkRemoteRun
  583.  
  584.    NAME
  585.    NCP_LinkRemoteRun -- use the NCP link channel to run a program on
  586.                         the remote machine.
  587.  
  588.    SYNOPSIS
  589.    error = NCP_LinkRemoteRun( filename, cmdline, cmdlinelen )
  590.    D0                            A0       A1        D0
  591.  
  592.    LONG NCP_LinkRemoteRun( STRPTR, APTR, ULONG );
  593.  
  594.    FUNCTION
  595.    Use the LINK supervisor channel to have the remote link
  596.    run a program. No NCP channel needs to be opened in order
  597.    to perform this operation.
  598.  
  599.    INPUTS
  600.    filename -- file name of the remote program to start
  601.    cmdline -- pointer to command line array. Note that
  602.               EPOC command lines are *NOT* zero terminated.
  603.    cmdlinelen -- length of command line in bytes. May be
  604.                  zero, in which case no command line
  605.                  is transfered.
  606.  
  607.    RESULT
  608.    error -- either an AmigaNCP specific error code or the
  609.             result code from the remote link.
  610.  
  611.    EXAMPLE
  612.    Have WORD.APP read the Amiga startup sequence:
  613.  
  614.        UBYTE cmdline[] = {
  615.         "OANCPTest\000 V TES\000REM::SYS:\S\STARTUP-SEQUENCE\000"
  616.        };
  617.        error = NCP_LinkRemoteRun( "WORD.APP", cmdline, sizeof( cmdline ) );
  618.  
  619.    NOTES
  620.    See the Psion SDK for more information about using commandlines and
  621.    the LINK process launch feature.
  622.  
  623.    BUGS
  624.    None known.
  625.  
  626.    SEE ALSO
  627.  
  628. ncp.library/NCP_OpenChannel                       ncp.library/NCP_OpenChannel
  629.  
  630.    NAME
  631.     NCP_OpenChannel -- open a NCP channel to attempt to connect to
  632.                       the remote.
  633.  
  634.    SYNOPSIS
  635.     channel = NCP_OpenChannel( localname, remotename, flags )
  636.       D0                          A0          A1        D0
  637.  
  638.     APTR NCP_OpenChannel( STRPTR, STRPTR, ULONG );
  639.  
  640.    FUNCTION
  641.     Opens an NCP channel. If remotename is not NULL, attempts
  642.     to connect to the remote process and fails with a NULL
  643.     return if the connection could not be made. If remotename
  644.     is NULL, creates a passive channel silently awaiting remote
  645.     connection.
  646.    
  647.    INPUTS
  648.     localname -- name of local "process"
  649.     remotename -- either NULL for a passive channel or
  650.                   the remote process name which to connect
  651.                   to
  652.     flags -- currently unused, leave at 0
  653.  
  654.    RESULT
  655.     channel -- pointer to a channel object. NULL in case of
  656.                an error, whereas additional error information
  657.                can be found in IoErr()
  658.  
  659.    EXAMPLE
  660.     To connect to the remote file server:
  661.  
  662.        APTR channel;
  663.        channel = NCP_OpenChannel( "TestHost", "SYS$RFSV.*", 0 );
  664.  
  665.  
  666.    NOTES
  667.     Opening an active channel will result in an attempt to
  668.     create an NCP connection and fail upon any error (including
  669.     serial failure or inexistance of the remote process).
  670.     Creating an passive channel will not cause an NCP connection
  671.     attempt; this is done upon the first I/O request made to
  672.     channel.
  673.  
  674.    BUGS
  675.     None known.
  676.  
  677.    SEE ALSO
  678.     NCP_CloseChannel()
  679.  
  680. ncp.library/NCP_Read                                     ncp.library/NCP_Read
  681.  
  682.    NAME
  683.     NCP_Read -- do a read request.
  684.  
  685.    SYNOPSIS
  686.     status = NCP_Read( channel, data, datasize )
  687.       D0                     A0    
  688.  
  689.     LONG NCP_Read( APTR, APTR, ULONG );
  690.  
  691.    FUNCTION
  692.     This is basically identical to calling NCP_BeginRead()
  693.     followed by NCP_WaitRead().
  694.    
  695.    INPUTS
  696.     channel -- a NCP channel created by NCP_OpenChannel()
  697.     data -- receive buffer
  698.     datasize -- receive buffer size
  699.  
  700.    RESULT
  701.     status -- number of bytes read or a negative error
  702.               number.
  703.              
  704.    EXAMPLE
  705.  
  706.    NOTES
  707.  
  708.    BUGS
  709.  
  710.    SEE ALSO
  711.     NCP_WaitRead(), NCP_BeginRead(), NCP_AbortRead(), NCP_CheckRead()
  712.  
  713. ncp.library/NCP_ReadSig                               ncp.library/NCP_ReadSig
  714.  
  715.    NAME
  716.     NCP_ReadSig -- return signal mask of channel read port.
  717.  
  718.    SYNOPSIS
  719.     sigmask = NCP_ReadSig( channel )
  720.       D0                     A0    
  721.  
  722.     ULONG NCP_ReadSig( APTR );
  723.  
  724.    FUNCTION
  725.     This function returns the signal mask of the read port
  726.     of the given NCP channel. This signal is set if a read
  727.     request completes.
  728.    
  729.    INPUTS
  730.     channel -- a NCP channel created by NCP_OpenChannel()
  731.  
  732.    RESULT
  733.     sigmask -- signal mask of read port.
  734.              
  735.    EXAMPLE
  736.  
  737.    NOTES
  738.     Note that this function returns a signal mask, not a signal bit number.
  739.  
  740.    BUGS
  741.  
  742.    SEE ALSO
  743.     NCP_BeginRead()
  744.  
  745. ncp.library/NCP_WaitRead                             ncp.library/NCP_WaitRead
  746.  
  747.    NAME
  748.     NCP_WaitRead -- complete a read request on the NCP channel.
  749.  
  750.    SYNOPSIS
  751.     result = NCP_WaitRead( channel )
  752.       D0                     A0    
  753.  
  754.     LONG NCP_WaitRead( APTR );
  755.  
  756.    FUNCTION
  757.     Waits for the current read request to finish and
  758.     returns the result.
  759.    
  760.    INPUTS
  761.     channel -- a NCP channel created by NCP_OpenChannel()
  762.  
  763.    RESULT
  764.     status -- number of bytes read or a negative error
  765.               number.
  766.              
  767.    EXAMPLE
  768.  
  769.    NOTES
  770.     Every read request startet with NCP_BeginRead() absolutely
  771.     must be followed by a NCP_WaitRead(), even if it already
  772.     finished or was aborted via NCP_AbortRead().
  773.  
  774.    BUGS
  775.     Calling this function without an queued read request
  776.     will hang up your process.
  777.  
  778.    SEE ALSO
  779.     NCP_Read(), NCP_BeginRead(), NCP_AbortRead(), NCP_CheckRead()
  780.  
  781. ncp.library/NCP_WaitWrite                           ncp.library/NCP_WaitWrite
  782.  
  783.    NAME
  784.     NCP_WaitWrite -- complete a write request on the NCP channel.
  785.  
  786.    SYNOPSIS
  787.     result = NCP_WaitWrite( channel )
  788.       D0                     A0    
  789.  
  790.     LONG NCP_WaitWrite( APTR );
  791.  
  792.    FUNCTION
  793.     Waits for the current write request to finish and
  794.     returns the result.
  795.    
  796.    INPUTS
  797.     channel -- a NCP channel created by NCP_OpenChannel()
  798.  
  799.    RESULT
  800.     status -- number of bytes written or a negative error
  801.               number.
  802.              
  803.    EXAMPLE
  804.  
  805.    NOTES
  806.     Every write request startet with NCP_BeginWrite() absolutely
  807.     must be followed by a NCP_WaitWrite(), even if it already
  808.     finished or was aborted via NCP_AbortWrite().
  809.  
  810.    BUGS
  811.     Calling this function without an queued write request
  812.     will hang up your process.
  813.  
  814.    SEE ALSO
  815.     NCP_Write(), NCP_BeginWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  816.  
  817. ncp.library/NCP_Write                                   ncp.library/NCP_Write
  818.  
  819.    NAME
  820.     NCP_Write -- do a write request.
  821.  
  822.    SYNOPSIS
  823.     status = NCP_Write( channel, data, datasize )
  824.       D0                   A0     A1      D0
  825.  
  826.     LONG NCP_Write( APTR, APTR, ULONG );
  827.  
  828.    FUNCTION
  829.     This is basically identical to calling NCP_BeginWrite()
  830.     followed by NCP_WaitWrite().
  831.    
  832.    INPUTS
  833.     channel -- a NCP channel created by NCP_OpenChannel()
  834.     data -- receive buffer
  835.     datasize -- receive buffer size
  836.  
  837.    RESULT
  838.     status -- number of bytes written or a negative error
  839.               number.
  840.              
  841.    EXAMPLE
  842.  
  843.    NOTES
  844.  
  845.    BUGS
  846.  
  847.    SEE ALSO
  848.     NCP_WaitWrite(), NCP_BeginWrite(), NCP_AbortWrite(), NCP_CheckWrite()
  849.  
  850. ncp.library/NCP_WriteSig                             ncp.library/NCP_WriteSig
  851.  
  852.    NAME
  853.     NCP_WriteSig -- return signal mask of channel write port.
  854.  
  855.    SYNOPSIS
  856.     sigmask = NCP_WriteSig( channel )
  857.       D0                     A0    
  858.  
  859.     ULONG NCP_WriteSig( APTR );
  860.  
  861.    FUNCTION
  862.     This function returns the signal mask of the write port
  863.     of the given NCP channel. This signal is set if a write
  864.     request completes.
  865.    
  866.    INPUTS
  867.     channel -- a NCP channel created by NCP_OpenChannel()
  868.  
  869.    RESULT
  870.     sigmask -- signal mask of write port.
  871.              
  872.    EXAMPLE
  873.  
  874.    NOTES
  875.     Note that this function returns a signal mask, not a signal bit number.
  876.  
  877.    BUGS
  878.  
  879.    SEE ALSO
  880.     NCP_BeginWrite()
  881.  
  882.